<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs for page presets.php</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="file-name">/src/presets.php</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
									<a href="#sec-includes">Includes</a>
			|							<a href="#sec-constants">Constants</a>
										</div>
	<div class="info-box-body">	
		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Contains site-wide configuration directives.</p>
<p class="description"><p>All configuration of this site is located in this file (site name,  filepaths, addresses, contact information, etc), the CSS files (site  visual layout), and the database (categories, users, etc).</p><p>PHP Version 5</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Alexander Adami &lt;<a href="mailto:adamia@rpi.edu">adamia@rpi.edu</a>&gt;</li>
				<li><span class="field">author:</span> Aaron Ryden &lt;<a href="mailto:aryden@gmail.com">aryden@gmail.com</a>&gt;</li>
				<li><span class="field">author:</span> Kevin Fodness &lt;<a href="mailto:kevin.fodness@gmail.com">kevin.fodness@gmail.com</a>&gt;</li>
				<li><span class="field">author:</span> Mike Pennisi &lt;<a href="mailto:mpennisi@andrew.cmu.edu">mpennisi@andrew.cmu.edu</a>&gt;</li>
				<li><span class="field">link:</span> <a href="http://code.google.com/p/buylocalopensourcerensselaer/">http://code.google.com/p/buylocalopensourcerensselaer/</a></li>
				<li><span class="field">license:</span> <a href="http://opensource.org/licenses/gpl-license.php">GNU Public License</a></li>
			</ul>
		
			</div>
</div>
		

	<a name="sec-includes"></a>	
	<div class="info-box">
		<div class="info-box-title">Includes</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Includes</span>
			|							<a href="#sec-constants">Constants</a>
															</div>
		<div class="info-box-body">	
			<a name="_function_errorhandler_php"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="include-title">
			<span class="include-type">require_once</span>
			(<span class="include-name"><a href="../BuyLocal/_src---functions---function_errorhandler.php.html">function_errorhandler.php</a></span>)
			(line <span class="line-number">119</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">uses:</span> <a href="../BuyLocal/_src---functions---function_errorhandler.php.html#functionerrorHandler">errorHandler()</a> - For custom error handling.</li>
			</ul>
	
</div>
<a name="_function_sanitizesuperglobals_php"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="include-title">
			<span class="include-type">require_once</span>
			(<span class="include-name"><a href="../BuyLocal/_src---functions---function_sanitizesuperglobals.php.html">function_sanitizesuperglobals.php</a></span>)
			(line <span class="line-number">122</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">uses:</span> <a href="../BuyLocal/_src---functions---function_sanitizesuperglobals.php.html#functionsanitizeSuperglobals">sanitizeSuperglobals()</a> - To sanitize user input.</li>
			</ul>
	
</div>
<a name="_function_valueof_php"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="include-title">
			<span class="include-type">require_once</span>
			(<span class="include-name"><a href="../BuyLocal/_src---functions---function_valueof.php.html">function_valueof.php</a></span>)
			(line <span class="line-number">125</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">uses:</span> <a href="../BuyLocal/_src---functions---function_valueof.php.html#functionvalueOf">valueOf()</a> - For safe handling of arrays.</li>
			</ul>
	
</div>
<a name="_function_autoload_php"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="include-title">
			<span class="include-type">require_once</span>
			(<span class="include-name"><a href="../BuyLocal/_src---functions---function_autoload.php.html">function_autoload.php</a></span>)
			(line <span class="line-number">116</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">uses:</span> <a href="../BuyLocal/_src---functions---function_autoload.php.html#function__autoload">__autoload()</a> - For automatically including classes later.</li>
			</ul>
	
</div>
		</div>
	</div>
	
	<a name="sec-constants"></a>	
	<div class="info-box">
		<div class="info-box-title">Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-includes">Includes</a>
				|						<span class="disabled">Constants</span>
											</div>
		<div class="info-box-body">	
			<a name="defineBASE_URL"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">BASE_URL</span> = 'http://www.example.com'
			(line <span class="line-number">33</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The base URL for the site.</p>
	
		
</div>
<a name="defineDATEFORMAT"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">DATEFORMAT</span> = 'F d, Y'
			(line <span class="line-number">142</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The date and time format.</p>
	
		
</div>
<a name="defineDBENGINE"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">DBENGINE</span> = 'mysqli'
			(line <span class="line-number">96</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The database engine to use.</p>
	
		
</div>
<a name="defineDBNAME"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">DBNAME</span> = 'exampledb'
			(line <span class="line-number">69</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The name of the database to use.</p>
	
		
</div>
<a name="defineDBPASS"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">DBPASS</span> = 'examplepass'
			(line <span class="line-number">75</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The password to connect to the database.</p>
	
		
</div>
<a name="defineDBSERVER"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">DBSERVER</span> = 'localhost'
			(line <span class="line-number">66</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The database server name.</p>
	
		
</div>
<a name="defineDBUSER"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">DBUSER</span> = 'exampleuser'
			(line <span class="line-number">72</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The username to connect to the database.</p>
	
		
</div>
<a name="defineD_DISTANCE"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">D_DISTANCE</span> = 'mi'
			(line <span class="line-number">60</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default unit of measurement for distance, either 'km' or 'mi'.</p>
	
		
</div>
<a name="defineD_ZIP"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">D_ZIP</span> = '12180'
			(line <span class="line-number">57</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">* The default zip code for an unregistered user.</p>
	
		
</div>
<a name="defineEPOCH"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">EPOCH</span> = valueOf(getdate(),0)
			(line <span class="line-number">136</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The UNIX epoch.</p>
	
		
</div>
<a name="defineERRORLOG"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">ERRORLOG</span> = '/path/to/log/errors.txt'
			(line <span class="line-number">51</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The full path to the error log file.</p>
	
		
</div>
<a name="defineEVENTS_PER_PAGE"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">EVENTS_PER_PAGE</span> = 10
			(line <span class="line-number">190</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The number of events to display per page.</p>
	
		
</div>
<a name="defineGM_API_KEY"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">GM_API_KEY</span> = ''
			(line <span class="line-number">202</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The Google Maps API Key. Leave this as '' unless you're getting errors.</p>
	
		
</div>
<a name="defineGM_GEOCODE_URL"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">GM_GEOCODE_URL</span> = 'http://maps.google.com/maps/geo?output=xml&amp;sensor=false&amp;key='.GM_API_KEY
			(line <span class="line-number">210</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The path to the Google Maps API Geocoding service.</p>
<p class="description"><p>An API Key does not seem to be required at the moment (Oct 2009), but the API  spec says it is.</p></p>
	
		
</div>
<a name="defineGM_URL"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">GM_URL</span> = 'http://maps.google.com/maps/api/js?sensor=false'
			(line <span class="line-number">199</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The path to the Google Maps API v3 script. No API key is required.</p>
	
		
</div>
<a name="defineINCLUDE_PATH"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">INCLUDE_PATH</span> = '/path/to/src'
			(line <span class="line-number">48</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The full root include path (the path to the 'src' directory).</p>
	
		
</div>
<a name="defineINSTALL_PASSWORD"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">INSTALL_PASSWORD</span> = ''
			(line <span class="line-number">78</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Installation passphrase. Required in order to use install.php.</p>
	
		
</div>
<a name="defineL_CONTACTDESC"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">L_CONTACTDESC</span> = 25
			(line <span class="line-number">178</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Length constant for contact information descriptions.</p>
	
		
</div>
<a name="defineL_EMAIL"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">L_EMAIL</span> = 320
			(line <span class="line-number">160</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Length constant for an email address.</p>
	
		
</div>
<a name="defineL_FAX"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">L_FAX</span> = 15
			(line <span class="line-number">175</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Length constant for a fax number.</p>
	
		
</div>
<a name="defineL_NAME"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">L_NAME</span> = 50
			(line <span class="line-number">169</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Length constant for a person's name.</p>
	
		
</div>
<a name="defineL_PASSWORD"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">L_PASSWORD</span> = 128
			(line <span class="line-number">163</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Length constant for a password.</p>
	
		
</div>
<a name="defineL_PHONE"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">L_PHONE</span> = 15
			(line <span class="line-number">172</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Length constant for a phone number.</p>
	
		
</div>
<a name="defineL_STOREADDR"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">L_STOREADDR</span> = 100
			(line <span class="line-number">184</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Length constant for a store's street address.</p>
	
		
</div>
<a name="defineL_STORENAME"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">L_STORENAME</span> = 100
			(line <span class="line-number">181</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Length constant for a store's name.</p>
	
		
</div>
<a name="defineL_ZIP"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">L_ZIP</span> = 10
			(line <span class="line-number">166</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Length constant for a zip code.</p>
	
		
</div>
<a name="definePAGE_URL"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">PAGE_URL</span> = 'http://'.$_SERVER['HTTP_HOST'].valueOf($_SERVER,'REQUEST_URI')
			(line <span class="line-number">222</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Stores the current page URL.</p>
	
		
</div>
<a name="defineRECAPTCHA_PRIV_KEY"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">RECAPTCHA_PRIV_KEY</span> = '6Lfl-gkAAAAAABdv_6uUvo3cAtsCrPCJjtvFE5c8'
			(line <span class="line-number">216</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The private key for the reCAPTCHA library.</p>
	
		
</div>
<a name="defineRECAPTCHA_PUB_KEY"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">RECAPTCHA_PUB_KEY</span> = '6Lfl-gkAAAAAAFMhntrLYKA4gFjCBl06KX4kbBZE'
			(line <span class="line-number">219</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The public key for the reCAPTCHA library.</p>
	
		
</div>
<a name="defineRELATIVE_PATH"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">RELATIVE_PATH</span> = '/'
			(line <span class="line-number">45</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The relative path (BASE_URL minus the hostname).  Must end in a /</p>
	
		
</div>
<a name="defineRETURN_ADDRESS"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">RETURN_ADDRESS</span> = 'noreply@example.com'
			(line <span class="line-number">63</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The return (from) address for system generated emails.</p>
	
		
</div>
<a name="defineR_ADMIN"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">R_ADMIN</span> = 3
			(line <span class="line-number">157</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Role constant for an administrator.</p>
	
		
</div>
<a name="defineR_GUEST"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">R_GUEST</span> = 0
			(line <span class="line-number">148</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Role constant for a guest.</p>
	
		
</div>
<a name="defineR_OWNER"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">R_OWNER</span> = 2
			(line <span class="line-number">154</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Role constant for a store owner.</p>
	
		
</div>
<a name="defineR_USER"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">R_USER</span> = 1
			(line <span class="line-number">151</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Role constant for a registered user.</p>
	
		
</div>
<a name="defineSEARCH_RADIUS"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">SEARCH_RADIUS</span> = '25,50,100,250,500'
			(line <span class="line-number">196</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The search radius options separated by commas with no spaces.</p>
	
		
</div>
<a name="defineSESSIONLENGTH"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">SESSIONLENGTH</span> = 3600
			(line <span class="line-number">145</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The session length, in seconds.</p>
	
		
</div>
<a name="defineSITENAME"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">SITENAME</span> = 'Buy Local'
			(line <span class="line-number">54</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The textual site name.</p>
	
		
</div>
<a name="defineSTORES_PER_PAGE"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">STORES_PER_PAGE</span> = 10
			(line <span class="line-number">187</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The number of stores to display per page.</p>
	
		
</div>
<a name="defineUSERS_PER_PAGE"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">USERS_PER_PAGE</span> = 10
			(line <span class="line-number">193</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The number of users to display per page (administrators).</p>
	
		
</div>
<a name="defineYEAR"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">YEAR</span> = valueOf(getdate(),'year')
			(line <span class="line-number">139</span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The current year.</p>
	
		
</div>
		</div>
	</div>
	
	
	
	<p class="notes" id="credit">
		Documentation generated on Sat, 19 Dec 2009 19:45:21 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>